<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>ADNS2080 driver</title>
<link href="tabs.css" rel="stylesheet" type="text/css" />
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="alias.css" rel="stylesheet" type="text/css" />
<script type="text/javascript" src="alias.js"></script>

<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
</script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
  $(document).ready(function() { searchBox.OnSelectItem(0); });
</script>


<script type="text/javascript">
  jQuery(document).ready(function () {
    if(gref){ // Number all _img and _table classes
      gref();
    }
  });
</script>

</head>
<body>
<div id="top"><!-- do not remove this div! -->

<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  
  
  <td style="padding-left: 0.5em;">
   <div id="projectname">nRF51 General Code Examples
   
   </div>
   
  </td>
  
  
  
 </tr>
 </tbody>
</table>
</div>

<!-- Generated by Doxygen 1.7.5 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li><a href="modules.html"><span>Modules</span></a></li>
      <li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
      <li><a href="files.html"><span>Files</span></a></li>
      <li>
        <div id="MSearchBox" class="MSearchBoxInactive">
        <span class="left">
          <img id="MSearchSelect" src="search/mag_sel.png"
               onmouseover="return searchBox.OnSearchSelectShow()"
               onmouseout="return searchBox.OnSearchSelectHide()"
               alt=""/>
          <input type="text" id="MSearchField" value="Search" accesskey="S"
               onfocus="searchBox.OnSearchFieldFocus(true)" 
               onblur="searchBox.OnSearchFieldFocus(false)" 
               onkeyup="searchBox.OnSearchFieldChange(event)"/>
          </span><span class="right">
            <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
          </span>
        </div>
      </li>
    </ul>
  </div>
</div>
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
  initNavTree('group__nrf__drivers__adns2080.html','');
</script>
<div id="doc-content">
<div class="header">
  <div class="summary">
<a href="#enum-members">Enumerations</a> &#124;
<a href="#func-members">Functions</a>  </div>
  <div class="headertitle">
<div class="title">ADNS2080 driver</div>  </div>
<div class="ingroups"><a class="el" href="group__nrf__drivers.html">Drivers</a></div></div>
<div class="contents">

<p>ADNS2080 mouse sensor driver.  
<a href="#details">More...</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="enum-members"></a>
Enumerations</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__nrf__drivers__adns2080.html#ga657b7b313f5cd8ed57cbbf09010e86a0">adns2080_status_t</a> { <a class="el" href="group__nrf__drivers__adns2080.html#gga657b7b313f5cd8ed57cbbf09010e86a0a36900d375db3b09dbd8c9911b2100d95">ADNS2080_OK</a>, 
<a class="el" href="group__nrf__drivers__adns2080.html#gga657b7b313f5cd8ed57cbbf09010e86a0aefeb7e53973aced23574c795e59c3c90">ADNS2080_SERIAL_COMM_FAILURE</a>, 
<a class="el" href="group__nrf__drivers__adns2080.html#gga657b7b313f5cd8ed57cbbf09010e86a0af712577c3d06b79119d08728bd326143">ADNS2080_CHIP_NOT_DETECTED</a>, 
<a class="el" href="group__nrf__drivers__adns2080.html#gga657b7b313f5cd8ed57cbbf09010e86a0a4c8338bb73d258fb9a3afa12ed4fab6e">ADNS2080_INVALID_PARAMETER</a>
 }</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__nrf__drivers__adns2080.html#ga0a2e533ff5cb6517085859827320e103">motion_output_polarity_t</a> { <a class="el" href="group__nrf__drivers__adns2080.html#gga0a2e533ff5cb6517085859827320e103a3af88cabf9c235c4819ef9d6ba3296b8">ADNS2080_MOTION_OUTPUT_POLARITY_LOW</a> =  0, 
<a class="el" href="group__nrf__drivers__adns2080.html#gga0a2e533ff5cb6517085859827320e103a21e1a4f8918c66c9756657f7439664df">ADNS2080_MOTION_OUTPUT_POLARITY_HIGH</a> =  1
 }</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__nrf__drivers__adns2080.html#gaf829efdc343990811ba18dd86c68ef41">motion_output_sensitivity_t</a> { <a class="el" href="group__nrf__drivers__adns2080.html#ggaf829efdc343990811ba18dd86c68ef41ac914f711978a260c7db987d8130b14c6">ADNS2080_MOTION_OUTPUT_SENSITIVITY_LEVEL</a> =  0, 
<a class="el" href="group__nrf__drivers__adns2080.html#ggaf829efdc343990811ba18dd86c68ef41a44ab7166499d9be9e69457f3507bff66">ADNS2080_MOTION_OUTPUT_SENSITIVITY_EDGE</a> =  1
 }</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__nrf__drivers__adns2080.html#gaa0379c80ab64ff7a2532eb33fd823d0f">adns2080_resolution_t</a> { <br/>
&#160;&#160;<a class="el" href="group__nrf__drivers__adns2080.html#ggaa0379c80ab64ff7a2532eb33fd823d0fa75e7d55b0d3d895e93ae34bcabc36930">ADNS2080_RESOLUTION_250DPI</a> =  1, 
<a class="el" href="group__nrf__drivers__adns2080.html#ggaa0379c80ab64ff7a2532eb33fd823d0fa3536fcd2eea68137e547fdacae1bcd55">ADNS2080_RESOLUTION_500DPI</a> =  2, 
<a class="el" href="group__nrf__drivers__adns2080.html#ggaa0379c80ab64ff7a2532eb33fd823d0fabcd6c08edd9e815b6c9f605bca2fb9e6">ADNS2080_RESOLUTION_1000DPI</a> =  0, 
<a class="el" href="group__nrf__drivers__adns2080.html#ggaa0379c80ab64ff7a2532eb33fd823d0fabab5302b37ed9c177843944931b5371e">ADNS2080_RESOLUTION_1250DPI</a> =  3, 
<br/>
&#160;&#160;<a class="el" href="group__nrf__drivers__adns2080.html#ggaa0379c80ab64ff7a2532eb33fd823d0fa6168ba0c1dc389709c3b057ee3448a62">ADNS2080_RESOLUTION_1500DPI</a> =  4, 
<a class="el" href="group__nrf__drivers__adns2080.html#ggaa0379c80ab64ff7a2532eb33fd823d0fac6d9218e253c98616116a984498446a8">ADNS2080_RESOLUTION_1750DPI</a> =  5, 
<a class="el" href="group__nrf__drivers__adns2080.html#ggaa0379c80ab64ff7a2532eb33fd823d0faa131317b2b497f0e95e301997a962607">ADNS2080_RESOLUTION_2000DPI</a> =  6
<br/>
 }</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__nrf__drivers__adns2080.html#gafb430f188555285bcf8790a6252b14dd">adns2080_mode_t</a> { <br/>
&#160;&#160;<a class="el" href="group__nrf__drivers__adns2080.html#ggafb430f188555285bcf8790a6252b14dda32cb5949be03fb7299b9542cb29a8dd7">ADNS2080_MODE_NORMAL</a> =  0, 
<a class="el" href="group__nrf__drivers__adns2080.html#ggafb430f188555285bcf8790a6252b14dda7664c8aef84bb061d0a2597b6142b929">ADNS2080_MODE_REST1</a> =  1, 
<a class="el" href="group__nrf__drivers__adns2080.html#ggafb430f188555285bcf8790a6252b14ddae74819133d0ba3040389c7e20cfdd731">ADNS2080_MODE_REST2</a> =  2, 
<a class="el" href="group__nrf__drivers__adns2080.html#ggafb430f188555285bcf8790a6252b14dda57992612ffba69aa7b110e5e11540692">ADNS2080_MODE_REST3</a> =  3, 
<br/>
&#160;&#160;<a class="el" href="group__nrf__drivers__adns2080.html#ggafb430f188555285bcf8790a6252b14dda3c44ef7e8b4a68d816270cb787f21821">ADNS2080_MODE_RUN1</a> =  4, 
<a class="el" href="group__nrf__drivers__adns2080.html#ggafb430f188555285bcf8790a6252b14ddad5964569cccdfb0fa3a05d92498af522">ADNS2080_MODE_RUN2</a> =  5, 
<a class="el" href="group__nrf__drivers__adns2080.html#ggafb430f188555285bcf8790a6252b14ddaf9ea7226f63f9bc7cdfc09f21702fe4e">ADNS2080_MODE_IDLE</a> =  6
<br/>
 }</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__nrf__drivers__adns2080.html#ga31fa2de64250e9b0b6b90079dc0c268f">adns2080_motion_bits_t</a> { <a class="el" href="group__nrf__drivers__adns2080.html#gga31fa2de64250e9b0b6b90079dc0c268fa4bcd85d513b3fd22d72df39cb4fb5c4f">ADNS2080_MOTION_BITS_8</a> =  0, 
<a class="el" href="group__nrf__drivers__adns2080.html#gga31fa2de64250e9b0b6b90079dc0c268facd0f3314b9898064af180862fc2ea60c">ADNS2080_MOTION_BITS_12</a> =  1
 }</td></tr>
<tr><td colspan="2"><h2><a name="func-members"></a>
Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__nrf__drivers__adns2080.html#ga657b7b313f5cd8ed57cbbf09010e86a0">adns2080_status_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__nrf__drivers__adns2080.html#ga7abcaefa87c1e9452357ceaf16b0f367">adns2080_init</a> (void)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__nrf__drivers__adns2080.html#ga1fb641e4bbbd7f5aa99f59d34367cd6b">adns2080_reset</a> (void)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__nrf__drivers__adns2080.html#ga01a612c0b8e060261eb037b1385852dd">adns2080_product_id_read</a> (void)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__nrf__drivers__adns2080.html#ga0e5027fd02ac3036c0f7d99e6d197cfa">adns2080_revision_id_read</a> (void)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__nrf__drivers__adns2080.html#ga60d713c7a98bf1b326ec2cc51987fc44">adns2080_powerdown</a> (void)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__nrf__drivers__adns2080.html#gad6d99e8f21de3f6d728ebe032e86321c">adns2080_wakeup</a> (void)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__nrf__drivers__adns2080.html#ga657b7b313f5cd8ed57cbbf09010e86a0">adns2080_status_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__nrf__drivers__adns2080.html#ga69ec7d764a60e9b9f518a69e7e402b24">adns2080_motion_interrupt_set</a> (<a class="el" href="group__nrf__drivers__adns2080.html#ga0a2e533ff5cb6517085859827320e103">motion_output_polarity_t</a> polarity, <a class="el" href="group__nrf__drivers__adns2080.html#gaf829efdc343990811ba18dd86c68ef41">motion_output_sensitivity_t</a> sensitivity)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__nrf__drivers__adns2080.html#ga657b7b313f5cd8ed57cbbf09010e86a0">adns2080_status_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__nrf__drivers__adns2080.html#ga6671aadea596e9200f480ce0508eb776">adns2080_resolution_set</a> (<a class="el" href="group__nrf__drivers__adns2080.html#gaa0379c80ab64ff7a2532eb33fd823d0f">adns2080_resolution_t</a> resolution)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__nrf__drivers__adns2080.html#ga657b7b313f5cd8ed57cbbf09010e86a0">adns2080_status_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__nrf__drivers__adns2080.html#ga4a7a8b881d69ad88354a5455724d80aa">adns2080_motion_bits_set</a> (<a class="el" href="group__nrf__drivers__adns2080.html#ga31fa2de64250e9b0b6b90079dc0c268f">adns2080_motion_bits_t</a> motion_bits)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__nrf__drivers__adns2080.html#ga31fa2de64250e9b0b6b90079dc0c268f">adns2080_motion_bits_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__nrf__drivers__adns2080.html#ga6db887a23708021cc3576e12507dc66d">adns2080_motion_bits_read</a> (void)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__nrf__drivers__adns2080.html#gae6c580be751e0dd5a4e4828a36d8fcd2">adns2080_movement_read</a> (int16_t *p_delta_x, int16_t *p_delta_y)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__nrf__drivers__adns2080.html#ga801baebecd8050a212f8a8a51a9622b1">adns2080_is_motion_detected</a> (void)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__nrf__drivers__adns2080.html#ga21ef4dd412d7340b1df4c79f8bd5e87e">adns2080_rest_periods_set</a> (uint8_t rest1_period, uint8_t rest2_period, uint8_t rest3_period)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__nrf__drivers__adns2080.html#ga9cffab56583fbc577fc0b597eea7bb19">adns2080_downshift_times_set</a> (uint8_t run_to_rest1_mode_time, uint8_t rest1_to_rest2_mode_time, uint8_t rest2_to_rest3_mode_time)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__nrf__drivers__adns2080.html#ga54da01cd3b8230711d8ed00d5c74326b">adns2080_force_mode_set</a> (<a class="el" href="group__nrf__drivers__adns2080.html#gafb430f188555285bcf8790a6252b14dd">adns2080_mode_t</a> mode)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__nrf__drivers__adns2080.html#gafb430f188555285bcf8790a6252b14dd">adns2080_mode_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__nrf__drivers__adns2080.html#gad11f08fe46172ea478714722fdd74cf5">adns2080_force_mode_read</a> (void)</td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<p>ADNS2080 mouse sensor driver. </p>
<hr/><h2>Enumeration Type Documentation</h2>
<a class="anchor" id="ga657b7b313f5cd8ed57cbbf09010e86a0"></a><!-- doxytag: member="adns2080.h::adns2080_status_t" ref="ga657b7b313f5cd8ed57cbbf09010e86a0" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">enum <a class="el" href="group__nrf__drivers__adns2080.html#ga657b7b313f5cd8ed57cbbf09010e86a0">adns2080_status_t</a></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Describes return values for <a class="el" href="group__nrf__drivers__adns2080.html#ga7abcaefa87c1e9452357ceaf16b0f367">adns2080_init</a>. </p>
<dl><dt><b>Enumerator: </b></dt><dd><table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"><em><a class="anchor" id="gga657b7b313f5cd8ed57cbbf09010e86a0a36900d375db3b09dbd8c9911b2100d95"></a><!-- doxytag: member="ADNS2080_OK" ref="gga657b7b313f5cd8ed57cbbf09010e86a0a36900d375db3b09dbd8c9911b2100d95" args="" -->ADNS2080_OK</em>&nbsp;</td><td>
<p>Operation was succesful </p>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="gga657b7b313f5cd8ed57cbbf09010e86a0aefeb7e53973aced23574c795e59c3c90"></a><!-- doxytag: member="ADNS2080_SERIAL_COMM_FAILURE" ref="gga657b7b313f5cd8ed57cbbf09010e86a0aefeb7e53973aced23574c795e59c3c90" args="" -->ADNS2080_SERIAL_COMM_FAILURE</em>&nbsp;</td><td>
<p>Serial communication failed </p>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="gga657b7b313f5cd8ed57cbbf09010e86a0af712577c3d06b79119d08728bd326143"></a><!-- doxytag: member="ADNS2080_CHIP_NOT_DETECTED" ref="gga657b7b313f5cd8ed57cbbf09010e86a0af712577c3d06b79119d08728bd326143" args="" -->ADNS2080_CHIP_NOT_DETECTED</em>&nbsp;</td><td>
<p>Product/Revision ID was not what was expected </p>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="gga657b7b313f5cd8ed57cbbf09010e86a0a4c8338bb73d258fb9a3afa12ed4fab6e"></a><!-- doxytag: member="ADNS2080_INVALID_PARAMETER" ref="gga657b7b313f5cd8ed57cbbf09010e86a0a4c8338bb73d258fb9a3afa12ed4fab6e" args="" -->ADNS2080_INVALID_PARAMETER</em>&nbsp;</td><td>
<p>Given parameters were not valid </p>
</td></tr>
</table>
</dd>
</dl>

<p>Definition at line <a class="el" href="adns2080_8h_source.html#l00033">33</a> of file <a class="el" href="adns2080_8h_source.html">adns2080.h</a>.</p>

</div>
</div>
<a class="anchor" id="ga0a2e533ff5cb6517085859827320e103"></a><!-- doxytag: member="adns2080.h::motion_output_polarity_t" ref="ga0a2e533ff5cb6517085859827320e103" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">enum <a class="el" href="group__nrf__drivers__adns2080.html#ga0a2e533ff5cb6517085859827320e103">motion_output_polarity_t</a></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>ADNS2080 motion output pin polarity values. </p>
<dl><dt><b>Enumerator: </b></dt><dd><table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"><em><a class="anchor" id="gga0a2e533ff5cb6517085859827320e103a3af88cabf9c235c4819ef9d6ba3296b8"></a><!-- doxytag: member="ADNS2080_MOTION_OUTPUT_POLARITY_LOW" ref="gga0a2e533ff5cb6517085859827320e103a3af88cabf9c235c4819ef9d6ba3296b8" args="" -->ADNS2080_MOTION_OUTPUT_POLARITY_LOW</em>&nbsp;</td><td>
<p>Motion output polarity active low </p>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="gga0a2e533ff5cb6517085859827320e103a21e1a4f8918c66c9756657f7439664df"></a><!-- doxytag: member="ADNS2080_MOTION_OUTPUT_POLARITY_HIGH" ref="gga0a2e533ff5cb6517085859827320e103a21e1a4f8918c66c9756657f7439664df" args="" -->ADNS2080_MOTION_OUTPUT_POLARITY_HIGH</em>&nbsp;</td><td>
<p>Motion output polarity active high </p>
</td></tr>
</table>
</dd>
</dl>

<p>Definition at line <a class="el" href="adns2080_8h_source.html#l00044">44</a> of file <a class="el" href="adns2080_8h_source.html">adns2080.h</a>.</p>

</div>
</div>
<a class="anchor" id="gaf829efdc343990811ba18dd86c68ef41"></a><!-- doxytag: member="adns2080.h::motion_output_sensitivity_t" ref="gaf829efdc343990811ba18dd86c68ef41" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">enum <a class="el" href="group__nrf__drivers__adns2080.html#gaf829efdc343990811ba18dd86c68ef41">motion_output_sensitivity_t</a></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Motion output pin configuration. </p>
<dl><dt><b>Enumerator: </b></dt><dd><table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"><em><a class="anchor" id="ggaf829efdc343990811ba18dd86c68ef41ac914f711978a260c7db987d8130b14c6"></a><!-- doxytag: member="ADNS2080_MOTION_OUTPUT_SENSITIVITY_LEVEL" ref="ggaf829efdc343990811ba18dd86c68ef41ac914f711978a260c7db987d8130b14c6" args="" -->ADNS2080_MOTION_OUTPUT_SENSITIVITY_LEVEL</em>&nbsp;</td><td>
<p>Motion output pin will be driven low/high (depending on the polarity setting) as long as there is motion data in DELTA registers </p>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="ggaf829efdc343990811ba18dd86c68ef41a44ab7166499d9be9e69457f3507bff66"></a><!-- doxytag: member="ADNS2080_MOTION_OUTPUT_SENSITIVITY_EDGE" ref="ggaf829efdc343990811ba18dd86c68ef41a44ab7166499d9be9e69457f3507bff66" args="" -->ADNS2080_MOTION_OUTPUT_SENSITIVITY_EDGE</em>&nbsp;</td><td>
<p>Motion output pin will be driven low/high (depending on the polarity setting) for 380 ns when motion is detected during rest modes </p>
</td></tr>
</table>
</dd>
</dl>

<p>Definition at line <a class="el" href="adns2080_8h_source.html#l00053">53</a> of file <a class="el" href="adns2080_8h_source.html">adns2080.h</a>.</p>

</div>
</div>
<a class="anchor" id="gaa0379c80ab64ff7a2532eb33fd823d0f"></a><!-- doxytag: member="adns2080.h::adns2080_resolution_t" ref="gaa0379c80ab64ff7a2532eb33fd823d0f" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">enum <a class="el" href="group__nrf__drivers__adns2080.html#gaa0379c80ab64ff7a2532eb33fd823d0f">adns2080_resolution_t</a></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Mouse sensor resolution values. </p>
<dl><dt><b>Enumerator: </b></dt><dd><table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"><em><a class="anchor" id="ggaa0379c80ab64ff7a2532eb33fd823d0fa75e7d55b0d3d895e93ae34bcabc36930"></a><!-- doxytag: member="ADNS2080_RESOLUTION_250DPI" ref="ggaa0379c80ab64ff7a2532eb33fd823d0fa75e7d55b0d3d895e93ae34bcabc36930" args="" -->ADNS2080_RESOLUTION_250DPI</em>&nbsp;</td><td>
<p>250 dpi resolution </p>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="ggaa0379c80ab64ff7a2532eb33fd823d0fa3536fcd2eea68137e547fdacae1bcd55"></a><!-- doxytag: member="ADNS2080_RESOLUTION_500DPI" ref="ggaa0379c80ab64ff7a2532eb33fd823d0fa3536fcd2eea68137e547fdacae1bcd55" args="" -->ADNS2080_RESOLUTION_500DPI</em>&nbsp;</td><td>
<p>500 dpi resolution </p>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="ggaa0379c80ab64ff7a2532eb33fd823d0fabcd6c08edd9e815b6c9f605bca2fb9e6"></a><!-- doxytag: member="ADNS2080_RESOLUTION_1000DPI" ref="ggaa0379c80ab64ff7a2532eb33fd823d0fabcd6c08edd9e815b6c9f605bca2fb9e6" args="" -->ADNS2080_RESOLUTION_1000DPI</em>&nbsp;</td><td>
<p>1000 dpi resolution </p>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="ggaa0379c80ab64ff7a2532eb33fd823d0fabab5302b37ed9c177843944931b5371e"></a><!-- doxytag: member="ADNS2080_RESOLUTION_1250DPI" ref="ggaa0379c80ab64ff7a2532eb33fd823d0fabab5302b37ed9c177843944931b5371e" args="" -->ADNS2080_RESOLUTION_1250DPI</em>&nbsp;</td><td>
<p>1250 dpi resolution </p>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="ggaa0379c80ab64ff7a2532eb33fd823d0fa6168ba0c1dc389709c3b057ee3448a62"></a><!-- doxytag: member="ADNS2080_RESOLUTION_1500DPI" ref="ggaa0379c80ab64ff7a2532eb33fd823d0fa6168ba0c1dc389709c3b057ee3448a62" args="" -->ADNS2080_RESOLUTION_1500DPI</em>&nbsp;</td><td>
<p>1500 dpi resolution </p>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="ggaa0379c80ab64ff7a2532eb33fd823d0fac6d9218e253c98616116a984498446a8"></a><!-- doxytag: member="ADNS2080_RESOLUTION_1750DPI" ref="ggaa0379c80ab64ff7a2532eb33fd823d0fac6d9218e253c98616116a984498446a8" args="" -->ADNS2080_RESOLUTION_1750DPI</em>&nbsp;</td><td>
<p>1750 dpi resolution </p>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="ggaa0379c80ab64ff7a2532eb33fd823d0faa131317b2b497f0e95e301997a962607"></a><!-- doxytag: member="ADNS2080_RESOLUTION_2000DPI" ref="ggaa0379c80ab64ff7a2532eb33fd823d0faa131317b2b497f0e95e301997a962607" args="" -->ADNS2080_RESOLUTION_2000DPI</em>&nbsp;</td><td>
<p>2000 dpi resolution </p>
</td></tr>
</table>
</dd>
</dl>

<p>Definition at line <a class="el" href="adns2080_8h_source.html#l00062">62</a> of file <a class="el" href="adns2080_8h_source.html">adns2080.h</a>.</p>

</div>
</div>
<a class="anchor" id="gafb430f188555285bcf8790a6252b14dd"></a><!-- doxytag: member="adns2080.h::adns2080_mode_t" ref="gafb430f188555285bcf8790a6252b14dd" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">enum <a class="el" href="group__nrf__drivers__adns2080.html#gafb430f188555285bcf8790a6252b14dd">adns2080_mode_t</a></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Mouse sensor forced mode options. </p>
<dl><dt><b>Enumerator: </b></dt><dd><table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"><em><a class="anchor" id="ggafb430f188555285bcf8790a6252b14dda32cb5949be03fb7299b9542cb29a8dd7"></a><!-- doxytag: member="ADNS2080_MODE_NORMAL" ref="ggafb430f188555285bcf8790a6252b14dda32cb5949be03fb7299b9542cb29a8dd7" args="" -->ADNS2080_MODE_NORMAL</em>&nbsp;</td><td>
<p>Normal operation mode </p>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="ggafb430f188555285bcf8790a6252b14dda7664c8aef84bb061d0a2597b6142b929"></a><!-- doxytag: member="ADNS2080_MODE_REST1" ref="ggafb430f188555285bcf8790a6252b14dda7664c8aef84bb061d0a2597b6142b929" args="" -->ADNS2080_MODE_REST1</em>&nbsp;</td><td>
<p>Rest1 operation mode </p>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="ggafb430f188555285bcf8790a6252b14ddae74819133d0ba3040389c7e20cfdd731"></a><!-- doxytag: member="ADNS2080_MODE_REST2" ref="ggafb430f188555285bcf8790a6252b14ddae74819133d0ba3040389c7e20cfdd731" args="" -->ADNS2080_MODE_REST2</em>&nbsp;</td><td>
<p>Rest2 operation mode </p>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="ggafb430f188555285bcf8790a6252b14dda57992612ffba69aa7b110e5e11540692"></a><!-- doxytag: member="ADNS2080_MODE_REST3" ref="ggafb430f188555285bcf8790a6252b14dda57992612ffba69aa7b110e5e11540692" args="" -->ADNS2080_MODE_REST3</em>&nbsp;</td><td>
<p>Rest3 operation mode </p>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="ggafb430f188555285bcf8790a6252b14dda3c44ef7e8b4a68d816270cb787f21821"></a><!-- doxytag: member="ADNS2080_MODE_RUN1" ref="ggafb430f188555285bcf8790a6252b14dda3c44ef7e8b4a68d816270cb787f21821" args="" -->ADNS2080_MODE_RUN1</em>&nbsp;</td><td>
<p>Run1 operation mode </p>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="ggafb430f188555285bcf8790a6252b14ddad5964569cccdfb0fa3a05d92498af522"></a><!-- doxytag: member="ADNS2080_MODE_RUN2" ref="ggafb430f188555285bcf8790a6252b14ddad5964569cccdfb0fa3a05d92498af522" args="" -->ADNS2080_MODE_RUN2</em>&nbsp;</td><td>
<p>Run2 operation mode </p>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="ggafb430f188555285bcf8790a6252b14ddaf9ea7226f63f9bc7cdfc09f21702fe4e"></a><!-- doxytag: member="ADNS2080_MODE_IDLE" ref="ggafb430f188555285bcf8790a6252b14ddaf9ea7226f63f9bc7cdfc09f21702fe4e" args="" -->ADNS2080_MODE_IDLE</em>&nbsp;</td><td>
<p>Idle operation mode </p>
</td></tr>
</table>
</dd>
</dl>

<p>Definition at line <a class="el" href="adns2080_8h_source.html#l00076">76</a> of file <a class="el" href="adns2080_8h_source.html">adns2080.h</a>.</p>

</div>
</div>
<a class="anchor" id="ga31fa2de64250e9b0b6b90079dc0c268f"></a><!-- doxytag: member="adns2080.h::adns2080_motion_bits_t" ref="ga31fa2de64250e9b0b6b90079dc0c268f" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">enum <a class="el" href="group__nrf__drivers__adns2080.html#ga31fa2de64250e9b0b6b90079dc0c268f">adns2080_motion_bits_t</a></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Mouse sensor motion reporting bits. </p>
<dl><dt><b>Enumerator: </b></dt><dd><table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"><em><a class="anchor" id="gga31fa2de64250e9b0b6b90079dc0c268fa4bcd85d513b3fd22d72df39cb4fb5c4f"></a><!-- doxytag: member="ADNS2080_MOTION_BITS_8" ref="gga31fa2de64250e9b0b6b90079dc0c268fa4bcd85d513b3fd22d72df39cb4fb5c4f" args="" -->ADNS2080_MOTION_BITS_8</em>&nbsp;</td><td>
<p>Motion reporting uses 8 bits </p>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="gga31fa2de64250e9b0b6b90079dc0c268facd0f3314b9898064af180862fc2ea60c"></a><!-- doxytag: member="ADNS2080_MOTION_BITS_12" ref="gga31fa2de64250e9b0b6b90079dc0c268facd0f3314b9898064af180862fc2ea60c" args="" -->ADNS2080_MOTION_BITS_12</em>&nbsp;</td><td>
<p>Motion reporting uses 12 bits </p>
</td></tr>
</table>
</dd>
</dl>

<p>Definition at line <a class="el" href="adns2080_8h_source.html#l00090">90</a> of file <a class="el" href="adns2080_8h_source.html">adns2080.h</a>.</p>

</div>
</div>
<hr/><h2>Function Documentation</h2>
<a class="anchor" id="ga7abcaefa87c1e9452357ceaf16b0f367"></a><!-- doxytag: member="adns2080.h::adns2080_init" ref="ga7abcaefa87c1e9452357ceaf16b0f367" args="(void)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__nrf__drivers__adns2080.html#ga657b7b313f5cd8ed57cbbf09010e86a0">adns2080_status_t</a> adns2080_init </td>
          <td>(</td>
          <td class="paramtype">void&#160;</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Initializes the mouse sensor chip.</p>
<p>Valid mouse sensor information will be available 50 milliseconds after this function finishes.</p>
<dl class="return"><dt><b>Returns:</b></dt><dd></dd></dl>
<dl><dt><b>Return values:</b></dt><dd>
  <table class="retval">
    <tr><td class="paramname">ADNS2080_OK</td><td>Mouse sensor was initialized succesfully. </td></tr>
    <tr><td class="paramname">ADNS2080_SERIAL_COMM_FAILURE</td><td>Serial communications failure. </td></tr>
    <tr><td class="paramname">ADNS2080_CHIP_NOT_DETECTED</td><td>Could not find revision 0 ADNS2080 chip. </td></tr>
  </table>
  </dd>
</dl>

<p>Definition at line <a class="el" href="adns2080_8c_source.html#l00163">163</a> of file <a class="el" href="adns2080_8c_source.html">adns2080.c</a>.</p>

</div>
</div>
<a class="anchor" id="ga1fb641e4bbbd7f5aa99f59d34367cd6b"></a><!-- doxytag: member="adns2080.h::adns2080_reset" ref="ga1fb641e4bbbd7f5aa99f59d34367cd6b" args="(void)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void adns2080_reset </td>
          <td>(</td>
          <td class="paramtype">void&#160;</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Resets the mouse sensor chip.</p>
<p>Valid mouse sensor information will be available 50 milliseconds after this function finishes. All register settings will be lost and need to be reloaded. </p>

<p>Definition at line <a class="el" href="adns2080_8c_source.html#l00179">179</a> of file <a class="el" href="adns2080_8c_source.html">adns2080.c</a>.</p>

</div>
</div>
<a class="anchor" id="ga01a612c0b8e060261eb037b1385852dd"></a><!-- doxytag: member="adns2080.h::adns2080_product_id_read" ref="ga01a612c0b8e060261eb037b1385852dd" args="(void)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">uint8_t adns2080_product_id_read </td>
          <td>(</td>
          <td class="paramtype">void&#160;</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Reads mouse sensor product ID.</p>
<p>Chip is expected to be initialized before calling this function. Returned product ID should always be 0x2A.</p>
<dl class="return"><dt><b>Returns:</b></dt><dd>Product ID. </dd></dl>

<p>Definition at line <a class="el" href="adns2080_8c_source.html#l00153">153</a> of file <a class="el" href="adns2080_8c_source.html">adns2080.c</a>.</p>

</div>
</div>
<a class="anchor" id="ga0e5027fd02ac3036c0f7d99e6d197cfa"></a><!-- doxytag: member="adns2080.h::adns2080_revision_id_read" ref="ga0e5027fd02ac3036c0f7d99e6d197cfa" args="(void)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">uint8_t adns2080_revision_id_read </td>
          <td>(</td>
          <td class="paramtype">void&#160;</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Reads mouse sensor revision ID.</p>
<p>Chip is expected to be initialized before calling this function.</p>
<dl class="return"><dt><b>Returns:</b></dt><dd>Product ID. </dd></dl>

<p>Definition at line <a class="el" href="adns2080_8c_source.html#l00158">158</a> of file <a class="el" href="adns2080_8c_source.html">adns2080.c</a>.</p>

</div>
</div>
<a class="anchor" id="ga60d713c7a98bf1b326ec2cc51987fc44"></a><!-- doxytag: member="adns2080.h::adns2080_powerdown" ref="ga60d713c7a98bf1b326ec2cc51987fc44" args="(void)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void adns2080_powerdown </td>
          <td>(</td>
          <td class="paramtype">void&#160;</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Powers down the mouse sensor.</p>
<p>Chip is expected to be initialized before calling this function. Serial port should not be accessed during the power down. To exit the power down mode, <a class="el" href="group__nrf__drivers__adns2080.html#gad6d99e8f21de3f6d728ebe032e86321c">adns2080_wakeup</a> must be called. </p>

<p>Definition at line <a class="el" href="adns2080_8c_source.html#l00184">184</a> of file <a class="el" href="adns2080_8c_source.html">adns2080.c</a>.</p>

</div>
</div>
<a class="anchor" id="gad6d99e8f21de3f6d728ebe032e86321c"></a><!-- doxytag: member="adns2080.h::adns2080_wakeup" ref="gad6d99e8f21de3f6d728ebe032e86321c" args="(void)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void adns2080_wakeup </td>
          <td>(</td>
          <td class="paramtype">void&#160;</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Wakes up the mouse sensor.</p>
<p>After wakeup, all mouse sensor settings must be reloaded. Valid mouse sensor information will be available 55 milliseconds after this function finishes. </p>

<p>Definition at line <a class="el" href="adns2080_8c_source.html#l00189">189</a> of file <a class="el" href="adns2080_8c_source.html">adns2080.c</a>.</p>

</div>
</div>
<a class="anchor" id="ga69ec7d764a60e9b9f518a69e7e402b24"></a><!-- doxytag: member="adns2080.h::adns2080_motion_interrupt_set" ref="ga69ec7d764a60e9b9f518a69e7e402b24" args="(motion_output_polarity_t polarity, motion_output_sensitivity_t sensitivity)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__nrf__drivers__adns2080.html#ga657b7b313f5cd8ed57cbbf09010e86a0">adns2080_status_t</a> adns2080_motion_interrupt_set </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="group__nrf__drivers__adns2080.html#ga0a2e533ff5cb6517085859827320e103">motion_output_polarity_t</a>&#160;</td>
          <td class="paramname"><em>polarity</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="group__nrf__drivers__adns2080.html#gaf829efdc343990811ba18dd86c68ef41">motion_output_sensitivity_t</a>&#160;</td>
          <td class="paramname"><em>sensitivity</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Configures MOTION interrupt output pin.</p>
<p>When motion is detected by the mouse sensor, the chip has a MOTION pin indicating there is motion data in DELTA_X and DELTA_Y registers. This function configures the polarity and sensitivity of that pin.</p>
<p>Chip is expected to be initialized before calling this function.</p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table class="params">
    <tr><td class="paramname">polarity</td><td>MOTION output pin is either active LOW (default) or active HIGH </td></tr>
    <tr><td class="paramname">sensitivity</td><td>Level or Edge (default) sensitive </td></tr>
  </table>
  </dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd></dd></dl>
<dl><dt><b>Return values:</b></dt><dd>
  <table class="retval">
    <tr><td class="paramname">ADNS2080_OK</td><td>Operation succeeded. </td></tr>
    <tr><td class="paramname">ADNS2080_INVALID_PARAMETER</td><td>One of the parameters was not within valid range. </td></tr>
  </table>
  </dd>
</dl>

<p>Definition at line <a class="el" href="adns2080_8c_source.html#l00194">194</a> of file <a class="el" href="adns2080_8c_source.html">adns2080.c</a>.</p>

</div>
</div>
<a class="anchor" id="ga6671aadea596e9200f480ce0508eb776"></a><!-- doxytag: member="adns2080.h::adns2080_resolution_set" ref="ga6671aadea596e9200f480ce0508eb776" args="(adns2080_resolution_t resolution)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__nrf__drivers__adns2080.html#ga657b7b313f5cd8ed57cbbf09010e86a0">adns2080_status_t</a> adns2080_resolution_set </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="group__nrf__drivers__adns2080.html#gaa0379c80ab64ff7a2532eb33fd823d0f">adns2080_resolution_t</a>&#160;</td>
          <td class="paramname"><em>resolution</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Sets mouse sensor resolution.</p>
<p>Chip is expected to be initialized before calling this function.</p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table class="params">
    <tr><td class="paramname">resolution</td><td>Desired resolution. </td></tr>
  </table>
  </dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd></dd></dl>
<dl><dt><b>Return values:</b></dt><dd>
  <table class="retval">
    <tr><td class="paramname">ADNS2080_OK</td><td>Operation succeeded. </td></tr>
    <tr><td class="paramname">ADNS2080_INVALID_PARAMETER</td><td>One of the parameters was not within valid range. </td></tr>
  </table>
  </dd>
</dl>

<p>Definition at line <a class="el" href="adns2080_8c_source.html#l00237">237</a> of file <a class="el" href="adns2080_8c_source.html">adns2080.c</a>.</p>

</div>
</div>
<a class="anchor" id="ga4a7a8b881d69ad88354a5455724d80aa"></a><!-- doxytag: member="adns2080.h::adns2080_motion_bits_set" ref="ga4a7a8b881d69ad88354a5455724d80aa" args="(adns2080_motion_bits_t motion_bits)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__nrf__drivers__adns2080.html#ga657b7b313f5cd8ed57cbbf09010e86a0">adns2080_status_t</a> adns2080_motion_bits_set </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="group__nrf__drivers__adns2080.html#ga31fa2de64250e9b0b6b90079dc0c268f">adns2080_motion_bits_t</a>&#160;</td>
          <td class="paramname"><em>motion_bits</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Sets number of bits used for mouse sensor motion reporting.</p>
<p>Chip is expected to be initialized before calling this function.</p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table class="params">
    <tr><td class="paramname">motion_bits</td><td>Desired number of bits. </td></tr>
  </table>
  </dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd></dd></dl>
<dl><dt><b>Return values:</b></dt><dd>
  <table class="retval">
    <tr><td class="paramname">ADNS2080_OK</td><td>Operation succeeded. </td></tr>
    <tr><td class="paramname">ADNS2080_INVALID_PARAMETER</td><td>One of the parameters was not within valid range. </td></tr>
  </table>
  </dd>
</dl>

<p>Definition at line <a class="el" href="adns2080_8c_source.html#l00273">273</a> of file <a class="el" href="adns2080_8c_source.html">adns2080.c</a>.</p>

</div>
</div>
<a class="anchor" id="ga6db887a23708021cc3576e12507dc66d"></a><!-- doxytag: member="adns2080.h::adns2080_motion_bits_read" ref="ga6db887a23708021cc3576e12507dc66d" args="(void)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__nrf__drivers__adns2080.html#ga31fa2de64250e9b0b6b90079dc0c268f">adns2080_motion_bits_t</a> adns2080_motion_bits_read </td>
          <td>(</td>
          <td class="paramtype">void&#160;</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Reads number of bits used for mouse sensor motion reporting.</p>
<p>Chip is expected to be initialized before calling this function.</p>
<dl class="return"><dt><b>Returns:</b></dt><dd>motion_bits Number of bits. </dd></dl>

<p>Definition at line <a class="el" href="adns2080_8c_source.html#l00142">142</a> of file <a class="el" href="adns2080_8c_source.html">adns2080.c</a>.</p>

</div>
</div>
<a class="anchor" id="gae6c580be751e0dd5a4e4828a36d8fcd2"></a><!-- doxytag: member="adns2080.h::adns2080_movement_read" ref="gae6c580be751e0dd5a4e4828a36d8fcd2" args="(int16_t *p_delta_x, int16_t *p_delta_y)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void adns2080_movement_read </td>
          <td>(</td>
          <td class="paramtype">int16_t *&#160;</td>
          <td class="paramname"><em>p_delta_x</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int16_t *&#160;</td>
          <td class="paramname"><em>p_delta_y</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Reads X- and Y-axis movement (in counts) since last report.</p>
<p>Absolute value is determined by resolution. Chip is expected to be initialized before calling this function.</p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table class="params">
    <tr><td class="paramname">p_delta_x</td><td>Location to store X-axis movement </td></tr>
    <tr><td class="paramname">p_delta_y</td><td>Location to store Y-axis movement </td></tr>
  </table>
  </dd>
</dl>
<p>&lt; Stores REG_DELTA_X contents</p>
<p>&lt; Stores REG_DELTA_Y contents</p>
<p>&lt; Stores REG_DELTA_XY contents which contains upper 4 bits for both delta_x and delta_y when 12 bit mode is used</p>
<p>&lt; Stores delta_x 4 MSB bits</p>
<p>&lt; Stores delta_y 4 MSB bits</p>
<p>&lt; This is used to buffer the result and will be cast later to int16_t</p>
<p>&lt; This is used to buffer the result and will be cast later to int16_t </p>

<p>Definition at line <a class="el" href="adns2080_8c_source.html#l00062">62</a> of file <a class="el" href="adns2080_8c_source.html">adns2080.c</a>.</p>

</div>
</div>
<a class="anchor" id="ga801baebecd8050a212f8a8a51a9622b1"></a><!-- doxytag: member="adns2080.h::adns2080_is_motion_detected" ref="ga801baebecd8050a212f8a8a51a9622b1" args="(void)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool adns2080_is_motion_detected </td>
          <td>(</td>
          <td class="paramtype">void&#160;</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Checks if motion has been detected since last call.</p>
<p>Chip is expected to be initialized before calling this function.</p>
<dl class="return"><dt><b>Returns:</b></dt><dd></dd></dl>
<dl><dt><b>Return values:</b></dt><dd>
  <table class="retval">
    <tr><td class="paramname">true,if</td><td>movement has been detected </td></tr>
    <tr><td class="paramname">false,if</td><td>no movement has been detected </td></tr>
  </table>
  </dd>
</dl>

<p>Definition at line <a class="el" href="adns2080_8c_source.html#l00148">148</a> of file <a class="el" href="adns2080_8c_source.html">adns2080.c</a>.</p>

</div>
</div>
<a class="anchor" id="ga21ef4dd412d7340b1df4c79f8bd5e87e"></a><!-- doxytag: member="adns2080.h::adns2080_rest_periods_set" ref="ga21ef4dd412d7340b1df4c79f8bd5e87e" args="(uint8_t rest1_period, uint8_t rest2_period, uint8_t rest3_period)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void adns2080_rest_periods_set </td>
          <td>(</td>
          <td class="paramtype">uint8_t&#160;</td>
          <td class="paramname"><em>rest1_period</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">uint8_t&#160;</td>
          <td class="paramname"><em>rest2_period</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">uint8_t&#160;</td>
          <td class="paramname"><em>rest3_period</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Sets mouse sensor Rest1, Rest2 and Rest3 mode motion detection time period.</p>
<p>Allowed range for the periods is 0x01 to 0xFD. Resulting period is derived from the following equation : Period = (Rest period + 1) * 10 milliseconds Chip is expected to be initialized before calling this function.</p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table class="params">
    <tr><td class="paramname">rest1_period</td><td>Rest1 period </td></tr>
    <tr><td class="paramname">rest2_period</td><td>Rest2 period </td></tr>
    <tr><td class="paramname">rest3_period</td><td>Rest3 period </td></tr>
  </table>
  </dd>
</dl>

<p>Definition at line <a class="el" href="adns2080_8c_source.html#l00301">301</a> of file <a class="el" href="adns2080_8c_source.html">adns2080.c</a>.</p>

</div>
</div>
<a class="anchor" id="ga9cffab56583fbc577fc0b597eea7bb19"></a><!-- doxytag: member="adns2080.h::adns2080_downshift_times_set" ref="ga9cffab56583fbc577fc0b597eea7bb19" args="(uint8_t run_to_rest1_mode_time, uint8_t rest1_to_rest2_mode_time, uint8_t rest2_to_rest3_mode_time)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void adns2080_downshift_times_set </td>
          <td>(</td>
          <td class="paramtype">uint8_t&#160;</td>
          <td class="paramname"><em>run_to_rest1_mode_time</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">uint8_t&#160;</td>
          <td class="paramname"><em>rest1_to_rest2_mode_time</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">uint8_t&#160;</td>
          <td class="paramname"><em>rest2_to_rest3_mode_time</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Sets mouse sensor mode downshift time periods.</p>
<p>Allowed range for run_to_rest1_mode_time period is 0x00 to 0xFF. Allowed range for rest1_to_rest2_mode_time period is 0x01 to 0xFF. Allowed range for rest2_to_rest3_mode_time period is 0x01 to 0xFF.</p>
<p>Chip is expected to be initialized before calling this function.</p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table class="params">
    <tr><td class="paramname">run_to_rest1_mode_time</td><td>Run mode to Rest1 mode downshift time period (Time = run_to_rest1_mode_time * 8 * 4) </td></tr>
    <tr><td class="paramname">rest1_to_rest2_mode_time</td><td>Rest1 mode to Rest2 mode downshift time period (Time = rest1_to_rest2_mode_time * rest1_period * 16) </td></tr>
    <tr><td class="paramname">rest2_to_rest3_mode_time</td><td>Rest2 mode to Rest3 mode downshift time period (Time = rest2_to_rest3_mode_time * rest2_period * 128) </td></tr>
  </table>
  </dd>
</dl>

<p>Definition at line <a class="el" href="adns2080_8c_source.html#l00311">311</a> of file <a class="el" href="adns2080_8c_source.html">adns2080.c</a>.</p>

</div>
</div>
<a class="anchor" id="ga54da01cd3b8230711d8ed00d5c74326b"></a><!-- doxytag: member="adns2080.h::adns2080_force_mode_set" ref="ga54da01cd3b8230711d8ed00d5c74326b" args="(adns2080_mode_t mode)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void adns2080_force_mode_set </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="group__nrf__drivers__adns2080.html#gafb430f188555285bcf8790a6252b14dd">adns2080_mode_t</a>&#160;</td>
          <td class="paramname"><em>mode</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Forces mouse sensor to a certain operating mode.</p>
<p>Chip is expected to be initialized before calling this function. Normal operation will not continue until this function is called with ADNS2080_MODE_NORMAL parameter.</p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table class="params">
    <tr><td class="paramname">mode</td><td>Mode to force the sensor to. </td></tr>
  </table>
  </dd>
</dl>

<p>Definition at line <a class="el" href="adns2080_8c_source.html#l00326">326</a> of file <a class="el" href="adns2080_8c_source.html">adns2080.c</a>.</p>

</div>
</div>
<a class="anchor" id="gad11f08fe46172ea478714722fdd74cf5"></a><!-- doxytag: member="adns2080.h::adns2080_force_mode_read" ref="gad11f08fe46172ea478714722fdd74cf5" args="(void)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__nrf__drivers__adns2080.html#gafb430f188555285bcf8790a6252b14dd">adns2080_mode_t</a> adns2080_force_mode_read </td>
          <td>(</td>
          <td class="paramtype">void&#160;</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Reads current forced operating mode.</p>
<p>Chip is expected to be initialized before calling this function.</p>
<dl class="return"><dt><b>Returns:</b></dt><dd>Mode the sensor is forced to. </dd></dl>

<p>Definition at line <a class="el" href="adns2080_8c_source.html#l00321">321</a> of file <a class="el" href="adns2080_8c_source.html">adns2080.c</a>.</p>

</div>
</div>
</div>
</div>
  <div id="nav-path" class="navpath">
    <ul>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Defines</a></div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>


    <li class="footer">
      Copyright &copy 2006-2011 <a href="http://www.nordicsemi.no" style="text-decoration:none">Nordic Semiconductor</a>.
      All Rights Reserved.
      <a href="disclaimer.html">Disclaimer</a>
    </li>
   </ul>
 </div>


</body>
</html>
